<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: PDFDocumentProxy</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: PDFDocumentProxy</h1>

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="module-pdfjsLib.html">pdfjsLib</a>~</span>PDFDocumentProxy<span class="signature">()</span><span class="type-signature"></span></h2>
        
            <div class="class-description">Proxy to a `PDFDocument` in the worker thread.</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    
    <h2>Constructor</h2>
    

    
    <h4 class="name" id="PDFDocumentProxy"><span class="type-signature"></span>new PDFDocumentProxy<span class="signature">()</span><span class="type-signature"></span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line731">line 731</a>
    </li></ul></dd>
    

    

    

    
</dl>




















    
    </div>

    

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id="allXfaHtml"><span class="type-signature"></span>allXfaHtml<span class="type-signature"> :Object|null</span></h4>




<div class="description">
    NOTE: This is (mostly) intended to support printing of XFA forms.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line795">line 795</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="annotationStorage"><span class="type-signature"></span>annotationStorage<span class="type-signature"> :AnnotationStorage</span></h4>




<div class="description">
    Storage for annotation data in forms.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">AnnotationStorage</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line740">line 740</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="fingerprints"><span class="type-signature"></span>fingerprints<span class="type-signature"> :Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, (string:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span></h4>




<div class="description">
    A (not guaranteed to be) unique ID to  identify the PDF document.  NOTE: The first element will always be defined for all PDF documents,  whereas the second element is only defined for *modified* PDF documents.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, (string:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line757">line 757</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="isPureXfa"><span class="type-signature"></span>isPureXfa<span class="type-signature"> :boolean</span></h4>




<div class="description">
    True if only XFA form.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line785">line 785</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="loadingParams"><span class="type-signature"></span>loadingParams<span class="type-signature"> :DocumentInitParameters</span></h4>




<div class="description">
    A subset of the current  {DocumentInitParameters}, which are needed in the viewer.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">DocumentInitParameters</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1029">line 1029</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="loadingTask"><span class="type-signature"></span>loadingTask<span class="type-signature"> :PDFDocumentLoadingTask</span></h4>




<div class="description">
    The loadingTask for the current document.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">PDFDocumentLoadingTask</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1036">line 1036</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="numPages"><span class="type-signature"></span>numPages<span class="type-signature"> :number</span></h4>




<div class="description">
    Total number of pages in the PDF file.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line747">line 747</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="stats"><span class="type-signature"></span>stats<span class="type-signature"> :PDFDocumentStats|null</span></h4>




<div class="description">
    The current statistics about document  structures, or `null` when no statistics exists.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">PDFDocumentStats</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line775">line 775</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="cleanup"><span class="type-signature"></span>cleanup<span class="signature">(keepLoadedFonts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
    

    



<div class="description">
    Cleans up resources allocated by the document on both the main and worker
threads.

NOTE: Do not, under any circumstances, call this method when rendering is
currently ongoing since that may lead to rendering errors.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>keepLoadedFonts</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">Let fonts remain attached to the DOM.
  NOTE: This will increase persistent memory usage, hence don't use this
  option unless absolutely necessary. The default value is `false`.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1014">line 1014</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved when clean-up has finished.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Destroys the current document instance and terminates the worker.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1021">line 1021</a>
    </li></ul></dd>
    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getAttachments"><span class="type-signature"></span>getAttachments<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line884">line 884</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with a lookup table
  for mapping named attachments to their content.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getCalculationOrderIds"><span class="type-signature"></span>getCalculationOrderIds<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1062">line 1062</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with an
  {Array<string>} containing IDs of annotations that have a calculation
  action, or `null` when no such annotations are present in the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getData"><span class="type-signature"></span>getData<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Uint8Array:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line981">line 981</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with a
  {Uint8Array} containing the raw data of the PDF document.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Uint8Array:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getDestination"><span class="type-signature"></span>getDestination<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">The named destination to get.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line833">line 833</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with all
  information of the given named destination, or `null` when the named
  destination is not present in the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getDestinations"><span class="type-signature"></span>getDestinations<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Object:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>>>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line823">line 823</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved
  with a mapping from named destinations to references.

This can be slow for large documents. Use `getDestination` instead.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Object:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>>>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getDownloadInfo"><span class="type-signature"></span>getDownloadInfo<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;{length:<a href="module-pdfjsLib-PDFObjects.html"></a>: number:<a href="module-pdfjsLib-PDFObjects.html"></a>}>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line998">line 998</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved when the
  document's data is loaded. It is resolved with an {Object} that contains
  the `length` property that indicates size of the PDF data in bytes.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;{length:<a href="module-pdfjsLib-PDFObjects.html"></a>: number:<a href="module-pdfjsLib-PDFObjects.html"></a>}></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getFieldObjects"><span class="type-signature"></span>getFieldObjects<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Object:<a href="module-pdfjsLib-PDFObjects.html"></a>>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1045">line 1045</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is
  resolved with an {Object} containing /AcroForm field data for the JS
  sandbox, or `null` when no field data is present in the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Object:<a href="module-pdfjsLib-PDFObjects.html"></a>>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getJSActions"><span class="type-signature"></span>getJSActions<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line904">line 904</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  an {Object} with the JavaScript actions:
    - from the name tree (like getJavaScript);
    - from A or AA entries in the catalog dictionary.
  , or `null` if no JavaScript exists.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getJavaScript"><span class="type-signature"></span>getJavaScript<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line893">line 893</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  an {Array} of all the JavaScript strings in the name tree, or `null`
  if no JavaScript exists.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getMarkInfo"><span class="type-signature"></span>getMarkInfo<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(MarkInfo:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line973">line 973</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  a {MarkInfo} object that contains the MarkInfo flags for the PDF
  document, or `null` when no MarkInfo values are present in the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(MarkInfo:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getMetadata"><span class="type-signature"></span>getMetadata<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;{info:<a href="module-pdfjsLib-PDFObjects.html"></a>: Object:<a href="module-pdfjsLib-PDFObjects.html"></a>, metadata:<a href="module-pdfjsLib-PDFObjects.html"></a>: Metadata:<a href="module-pdfjsLib-PDFObjects.html"></a>}>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line956">line 956</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is
  resolved with an {Object} that has `info` and `metadata` properties.
  `info` is an {Object} filled with anything available in the information
  dictionary and similarly `metadata` is a {Metadata} object with
  information from the metadata section of the PDF.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;{info:<a href="module-pdfjsLib-PDFObjects.html"></a>: Object:<a href="module-pdfjsLib-PDFObjects.html"></a>, metadata:<a href="module-pdfjsLib-PDFObjects.html"></a>: Metadata:<a href="module-pdfjsLib-PDFObjects.html"></a>}></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getOpenAction"><span class="type-signature"></span>getOpenAction<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(any:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line876">line 876</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with an {Array}
  containing the destination, or `null` when no open action is present
  in the PDF.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(any:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getOptionalContentConfig"><span class="type-signature"></span>getOptionalContentConfig<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;OptionalContentConfig:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line936">line 936</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  an OptionalContentConfig that contains all the optional content
  groups (assuming that the document has any).
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;OptionalContentConfig:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getOutline"><span class="type-signature"></span>getOutline<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;OutlineNode:<a href="module-pdfjsLib-PDFObjects.html"></a>>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line927">line 927</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with an
  {Array} that is a tree outline (if it has one) of the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;OutlineNode:<a href="module-pdfjsLib-PDFObjects.html"></a>>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getPage"><span class="type-signature"></span>getPage<span class="signature">(pageNumber)</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;PDFPageProxy:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pageNumber</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">The page number to get. The first page is 1.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line804">line 804</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  a PDFPageProxy object.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;PDFPageProxy:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getPageIndex"><span class="type-signature"></span>getPageIndex<span class="signature">(ref)</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ref</code></td>
            

            <td class="type">
            
                
<span class="param-type">RefProxy</span>


            
            </td>

            

            

            <td class="description last">The page reference.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line813">line 813</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with the page index,
  starting from zero, that is associated with the reference.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getPageLabels"><span class="type-signature"></span>getPageLabels<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line842">line 842</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  an {Array} containing the page labels that correspond to the page
  indexes, or `null` when no page labels are present in the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getPageLayout"><span class="type-signature"></span>getPageLayout<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line850">line 850</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with a {string}
  containing the page layout name.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getPageMode"><span class="type-signature"></span>getPageMode<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line858">line 858</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with a {string}
  containing the page mode name.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getPermissions"><span class="type-signature"></span>getPermissions<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line945">line 945</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  an {Array} that contains the permission flags for the PDF document, or
  `null` when no permissions are present in the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getViewerPreferences"><span class="type-signature"></span>getViewerPreferences<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line867">line 867</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with an
  {Object} containing the viewer preferences, or `null` when no viewer
  preferences are present in the PDF file.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="hasJSActions"><span class="type-signature"></span>hasJSActions<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;boolean:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1053">line 1053</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with `true`
  if some /AcroForm fields have JavaScript actions.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;boolean:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="saveDocument"><span class="type-signature"></span>saveDocument<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Uint8Array:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line989">line 989</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with a
  {Uint8Array} containing the full data of the saved document.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Uint8Array:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pdfjsLib.html">pdfjsLib</a></li></ul><h3>Classes</h3><ul><li><a href="module-pdfjsLib-PDFDataRangeTransport.html">PDFDataRangeTransport</a></li><li><a href="module-pdfjsLib-PDFDocumentLoadingTask.html">PDFDocumentLoadingTask</a></li><li><a href="module-pdfjsLib-PDFDocumentProxy.html">PDFDocumentProxy</a></li><li><a href="module-pdfjsLib-PDFObjects.html">PDFObjects</a></li><li><a href="module-pdfjsLib-PDFPageProxy.html">PDFPageProxy</a></li><li><a href="module-pdfjsLib-PDFWorker.html">PDFWorker</a></li><li><a href="module-pdfjsLib-RenderTask.html">RenderTask</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Mon Dec 19 2022 22:11:55 GMT+0000 (Coordinated Universal Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>